Inside Macintosh: Telephony /

Chapter 1 - Introduction to Telephony on the Macintosh / Telephone Manager Initialization Reference

Telephone Manager Initialization Functions / Configuring a Telephone Tool Through a Scripting Language

TELSetConfig

Sends a new configuration string to a telephone tool.

pascal short TELSetConfig (TELHandle hTEL, Ptr thePtr);

hTEL

The handle for the telephone record associated with the telephone tool.

thePtr

A pointer to the null-terminated string containing tokens that describe how the telephone tool is configured.

function result

A result code. When encountering an invalid token, the telephone tool ignores the occurrence and stops parsing the string at that point. If the telephone tool successfully parses the string, it returns the result code noErr. If a minor problem is encountered when parsing a single token, a positive number is returned indicating the character position where the parsing stopped. If the telephone tool encounters a serious problem, it returns a number less than -1 and terminates the parsing at that point. See "Result Codes" on page 1-58 for a list of other result codes that the Telephone Manager may return. This function also returns an operating-system error if any internal errors occur.

DESCRIPTION

The TELSetConfig function passes a null-terminated, C-style string to the telephone tool for parsing. The string, which can be of any length, is identified by the pointer thePtr and must contain valid tokens that describe the configuration of the telephone record. You can determine which tokens are valid for a given telephone tool by examining the string returned through the TELGetConfig function. Here is an example:

SLOT 9 OTHERFIELDS XXXX OTHERBOOLEANS TRUE\0

Each telephone tool is responsible for performing the parsing necessary to set the configuration.